API Documentation
WindowingSystem.h
1 // WindowingSystem.h
3 //
5 
6 namespace nkWinUi
7 {
11  enum class SYSTEM_TYPE
12  {
13  UNKNOWN = 0,
14  WIN_API
15 
16  #if defined(__EMSCRIPTEN__)
17  , JS_DOM
18  #endif
19  } ;
20 }
21 
22 namespace nkWinUi
23 {
28  {
29  public :
30 
31  // Constructor, destructor
39  WindowingSystem (MainSystem* parentSystem) ;
45  virtual ~WindowingSystem () ;
46 
47  // Getters
64 
65  // Initialisation
71  virtual bool load () = 0 ;
72 
73  // Run
80  virtual void run () = 0 ;
87  virtual void tick () = 0 ;
88 
89  // Shut down
95  virtual void prepareForShutdown () = 0 ;
101  virtual void shutdown () = 0 ;
102 
103  // Poke
108  virtual void notifyEvent () = 0 ;
109  } ;
110 }
nkWinUi::WindowingSystem::prepareForShutdown
virtual void prepareForShutdown()=0
nkWinUi::ComponentUtils
Offers many utilities to deal with the components, specialized for its windowing system.
Definition: ComponentUtils.h:12
nkWinUi::SYSTEM_TYPE::WIN_API
@ WIN_API
Using the Windows API.
nkWinUi::WindowingSystem::notifyEvent
virtual void notifyEvent()=0
nkWinUi::SYSTEM_TYPE::UNKNOWN
@ UNKNOWN
Unknown.
nkWinUi::WindowingSystem::shutdown
virtual void shutdown()=0
nkWinUi::WindowingSystem::tick
virtual void tick()=0
nkWinUi::WindowingSystem::load
virtual bool load()=0
nkWinUi::WindowingSystem::getSystemType
SYSTEM_TYPE getSystemType() const
nkWinUi::SYSTEM_TYPE
SYSTEM_TYPE
Windowing system types available and supported.
Definition: WindowingSystem.h:12
nkWinUi::MainSystem
The main system of the component.
Definition: MainSystem.h:18
nkWinUi::WindowingSystem::WindowingSystem
WindowingSystem(MainSystem *parentSystem)
nkWinUi::DataAllocator
The windowing system's data allocator.
Definition: DataAllocator.h:14
nkWinUi::WindowingSystem::getDataAllocator
DataAllocator * getDataAllocator() const
nkWinUi::WindowingSystem
Class abstracting the windowing system used.
Definition: WindowingSystem.h:28
nkWinUi::InputProcessor
A windowing system's input processor.
Definition: InputProcessor.h:15
nkWinUi
Encompasses all API of component NilkinsWinUi.
Definition: Clipboard.h:7
nkWinUi::WindowingSystem::getInputProcessor
InputProcessor * getInputProcessor() const
nkWinUi::WindowingSystem::getComponentUtils
ComponentUtils * getComponentUtils() const
nkWinUi::WindowingSystem::run
virtual void run()=0
nkWinUi::WindowingSystem::~WindowingSystem
virtual ~WindowingSystem()